<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
	<title>class Template</title>
	<style type="text/css">
	/* ZenDoc identity */
	.zendoc { font-family: Arial, Helvetica, sans-serif; margin:3px; }
	.zendoc a:hover { text-decoration:none; }
	.zendoc span.title-comment { font-family: Verdana, Arial, Helvetica, sans-serif; font-size:80%; color:#AAA; }
	.zendoc span.title-zen { color:#26A; font-weight:normal; }
	.zendoc span.title-doc { color:black; font-weight:bold; }
	/* overall */
	html, body, div { margin:0; padding:0; border:none; }
	body { font-family:Arial, Helvetica, sans-serif; font-size:90%; }
	a { text-decoration:none; }
	a:hover { text-decoration:underline; }
	h2 { color:#999; margin:2em 0 0 0; padding:0 2px 0 20px; border-bottom:2px solid #58B; }
	h3 { color:#B36B00; margin-top:3em; }
	dl { margin:.5em 0 3px 0; }
	dt { font-weight:bold; }
	td { vertical-align:top; }
	th { text-align:left; color:#58B; background-color:#E3ECF4; }
	code { font-size:1.1em; }
	/* specific */
	#header { background-color:#EAEAEA; padding:1px; }
	#links { color:#999; background-color:#FFE; border-bottom:1px solid #58B; padding:2px 20px; }
	#links a { color:#999; }
	.content { padding:10px 20px; }
	#class-definition { background-color:#58B; color:white; }
	#class-definition .classkind { font-weight:bold; }
	#class-definition .classkind .package { font-weight:normal; }
	#class-definition .classname { font-size:4em; margin:5px 0; }
	#class-definition .superclassname { padding-left:20px; font-style:italic; }
	#class-definition .implements { padding-left:20px; font-style:italic; }
	#class-info .content { margin:20px; border:1px solid #58B; }
	pre.definition { background-color:#FFE; border:1px solid #E4E29A; padding:3px; }
	.generated {
		font-style:italic;
		font-size:80%;
		color:#666;
		margin:1em 0 0 0;
		padding:5px 20px;
		border-top:1px solid #999;
	}
	/* tables */
	.member-list { border:1px solid #58B; margin:2em 20px; }
	.member-list a { color:#B36B00; }
	.member-list table { border-collapse:collapse; }
	.member-list td { border-top:1px solid #58B; }
	.member-list td.name { width:175px; text-align:right; padding-right:5px; }
	.member-list table { width:100%; }
	.even { background-color:#FFE; }
	.odd { background-color:white; }
	.param .name { color:#666; }
	</style>
</head>

<body>
<div id="page">
	<div id="header">
		<h4 class="zendoc"><a href="http://www.zendoc.org" title="ZenDoc Documentation Tool Home"><span class="title-comment">/**</span><span class="title-zen">Zen</span><span class="title-doc">Doc</span><span class="title-comment">--&gt;</span></a></h4>
	</div>
	<div id="class-definition" class="section">
		<div class="content">
			
			<div class="classkind">class <span class="package"></span></div>
			<h1 class="classname">Template</h1>
			
			<div class="superclassname">Extends: Sprite</div>
			<div class="implements">Implements: ITemplate</div>
		</div>
		<div id="links">
			<a href="#class-info">Class Information</a>
			
			 | <a href="#class-properties">Properties</a>
			 | <a href="#class-methods">Methods</a>
			
		</div>
	</div>
	
	<div id="class-info" class="section">
		<h2>Class Information</h2>
		<div class="content">
			
				<dl>
					
					
					<dt>Description</dt>
					<dd>Cette classe représente un template de page composé d'une liste de ressources de tous type accessibles.
Vous ne devez pas instancier cette classe vous même. Si vous faites votre propre template, votre classe doit hérité de celle ci pour pouvoir être géré par MainBase.
Si une ressource est de type DisplayElement, elle est ajouté à la liste d'affichage du template et est controlé par le template (appel des méthode init, display, close, etc...).</dd>
					
					public class Template extends Sprite implements ITemplate</dd>
					
				</dl>
			
			
			</div>
			
			
			
			
			<div class="member-list">
			<table><tr><th colspan="2">Properties</th></tr>
				<tr class="even">
					<td class="name"><a href="#tabDisplayElements">tabDisplayElements</a></td>
					<td>Renvoie un tableau contenant les DisplayElements affiché dans le template de page</td>
				</tr><tr class="odd">
					<td class="name"><a href="#xmlPage">xmlPage</a></td>
					<td>Renvoie le noeud xml se trouvant dans le xml templates correspondant à la page</td>
				</tr><tr class="even">
					<td class="name"><a href="#xmlRessource">xmlRessource</a></td>
					<td>Renvoie le noeud xml se trouvant dans le xml templates correspondant à la ressource associé à la page</td>
				</tr><tr class="odd">
					<td class="name"><a href="#uipage">uipage</a></td>
					<td>Renvoie l'identifiant de la page</td>
				</tr><tr class="even">
					<td class="name"><a href="#uiRessource">uiRessource</a></td>
					<td>Renvoie l'identifiant de la ressource associé à la page</td>
				</tr><tr class="odd">
					<td class="name"><a href="#ressources">ressources</a></td>
					<td>Renvoie un Object contenant les ressources chargées de la page. Exemple ressources["xmlPage1"] (renvoie une String) ou xmlPage1 correspond à l'id de la ressource déclaré dans le noeud de la page en cours</td>
				</tr>
			</table></div>
			
			
			<div class="member-list">
			<table><tr><th colspan="2">Methods</th></tr>
				<tr class="even">
					<td class="name"><a href="#init">init()</a></td>
					<td>Initilise la page. Appelé une seule fois par instance. Cette méthode est appelé par MainBase automatiquement quand une nouvelle page est créé et affichée. Vous pouvez redefinir cette méthode pour initialisé ce qui est spécifique à votre page.</td>
				</tr><tr class="odd">
					<td class="name"><a href="#display">display()</a></td>
					<td>Lance l'animation d'ouverture de la page. Cette méthode est appelé par MainBase automatiquement quand une page est affichée. Vous pouvez redefinir cette méthode pour effectuer votre propre animation.</td>
				</tr><tr class="even">
					<td class="name"><a href="#close">close()</a></td>
					<td>Lance l'animation de fermeture de la page. Cette méthode est appelé par MainBase automatiquement quand une page nouvelle page doit être affichée. Vous pouvez redefinir cette méthode pour effectuer votre propre animation.
Ne pas oublier d'appeler la méthode onCloseFinish quand votre animation est fini pour avertir MainBase que l'animation est fini.</td>
				</tr><tr class="odd">
					<td class="name"><a href="#onCloseFinish">onCloseFinish()</a></td>
					<td>Appelé cette méthode pour avertir que l'animation de fermeture de page est fini.
note : Elle est automatiquement appelé si vous utilisé la méthode de base close</td>
				</tr><tr class="even">
					<td class="name"><a href="#dispose">dispose()</a></td>
					<td>Pour tuer la classe (vider la mémoire etc...)</td>
				</tr><tr class="odd">
					<td class="name"><a href="#onDeepLinkChange">onDeepLinkChange()</a></td>
					<td>Cette méthode est déclanché automatiquement dés qu'il y a un changement de deepLink. Vous pouvez la redefinir pour effectuer les actions que vous voulez.</td>
				</tr>
			</table></div>
			
			
	</div>
		
	
	<br />
	<div id="class-properties" class="member-group section">
		<h2>Properties</h2>
		<div class="content">
			<div class="member-item">
				<h3 id="tabDisplayElements">tabDisplayElements</h3>
				<pre class="definition"><code>public function get tabDisplayElements():Array</code></pre>
				<div>Renvoie un tableau contenant les DisplayElements affiché dans le template de page</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="xmlPage">xmlPage</h3>
				<pre class="definition"><code>public function get xmlPage():XML</code></pre>
				<div>Renvoie le noeud xml se trouvant dans le xml templates correspondant à la page</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="xmlRessource">xmlRessource</h3>
				<pre class="definition"><code>public function get xmlRessource():XML</code></pre>
				<div>Renvoie le noeud xml se trouvant dans le xml templates correspondant à la ressource associé à la page</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="uipage">uipage</h3>
				<pre class="definition"><code>public function get uipage():String</code></pre>
				<div>Renvoie l'identifiant de la page</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="uiRessource">uiRessource</h3>
				<pre class="definition"><code>public function get uiRessource():String</code></pre>
				<div>Renvoie l'identifiant de la ressource associé à la page</div>
				
			
			
			
			
			</div>
		</div><div class="content">
			<div class="member-item">
				<h3 id="ressources">ressources</h3>
				<pre class="definition"><code>public function get ressources():Object</code></pre>
				<div>Renvoie un Object contenant les ressources chargées de la page. Exemple ressources["xmlPage1"] (renvoie une String) ou xmlPage1 correspond à l'id de la ressource déclaré dans le noeud de la page en cours</div>
				
			
			
			
			
			</div>
		</div>
	</div>
	<br />
	<div id="class-methods" class="member-group section">
		<h2>Methods</h2>
		<div class="content">
			<div class="member-item">
				<h3 id="init">init()</h3>
				<pre class="definition"><code>public function init():void</code></pre>
				<div>Initilise la page. Appelé une seule fois par instance. Cette méthode est appelé par MainBase automatiquement quand une nouvelle page est créé et affichée. Vous pouvez redefinir cette méthode pour initialisé ce qui est spécifique à votre page.</div>
				
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="display">display()</h3>
				<pre class="definition"><code>public function display():void</code></pre>
				<div>Lance l'animation d'ouverture de la page. Cette méthode est appelé par MainBase automatiquement quand une page est affichée. Vous pouvez redefinir cette méthode pour effectuer votre propre animation.</div>
				
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="close">close()</h3>
				<pre class="definition"><code>public function close():void</code></pre>
				<div>Lance l'animation de fermeture de la page. Cette méthode est appelé par MainBase automatiquement quand une page nouvelle page doit être affichée. Vous pouvez redefinir cette méthode pour effectuer votre propre animation.
Ne pas oublier d'appeler la méthode onCloseFinish quand votre animation est fini pour avertir MainBase que l'animation est fini.</div>
				
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="onCloseFinish">onCloseFinish()</h3>
				<pre class="definition"><code>public function onCloseFinish():void</code></pre>
				<div>Appelé cette méthode pour avertir que l'animation de fermeture de page est fini.
note : Elle est automatiquement appelé si vous utilisé la méthode de base close</div>
				
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="dispose">dispose()</h3>
				<pre class="definition"><code>public function dispose():void</code></pre>
				<div>Pour tuer la classe (vider la mémoire etc...)</div>
				
				
				
			
			
			
			
			</div><div class="member-item">
				<h3 id="onDeepLinkChange">onDeepLinkChange()</h3>
				<pre class="definition"><code>public function onDeepLinkChange():void</code></pre>
				<div>Cette méthode est déclanché automatiquement dés qu'il y a un changement de deepLink. Vous pouvez la redefinir pour effectuer les actions que vous voulez.</div>
				
				
				
			
			
			
			
			</div>
		</div>
	</div>
	
	<p class="generated">Page generated: 7:40 pm on March 31, 2010</p>
</div>
</body>
</html>